Skip to content

docs: add API reference developer guide, catalog, and bilingual sidebar#43

Merged
ysyneu merged 2 commits intomainfrom
docs/api-reference-setup
Apr 12, 2026
Merged

docs: add API reference developer guide, catalog, and bilingual sidebar#43
ysyneu merged 2 commits intomainfrom
docs/api-reference-setup

Conversation

@ysyneu
Copy link
Copy Markdown
Contributor

@ysyneu ysyneu commented Apr 12, 2026

Summary

  • Add bilingual sidebar labels to all 214 API operations via x-mint.metadata.sidebarTitle
  • Fix EN OpenAPI x-mint.href to include /en/ prefix (was causing 404s)
  • Create developer guide pages: Quick Start (with merged rate-limits and Open API vs Webhooks comparison), API Catalog (full 214-endpoint listing), Pagination
  • Move route rules to top-level sidebar group (was nested under channels)
  • Navbar "API Reference" link now points to Quick Start page

Test plan

  • mint broken-links passes (only pre-existing README link)
  • ZH sidebar shows Chinese labels (e.g., "分派故障" not "Incident assign")
  • EN sidebar shows English labels (e.g., "Assign incident")
  • API Reference navbar link navigates to Quick Start page
  • Quick Start page has no right-side example panel
  • API Catalog lists all 214 endpoints with working links
  • Pagination page cursor pagination links point to new API reference URLs

🤖 Generated with Claude Code

ysyneu and others added 2 commits April 12, 2026 16:05
…sidebar

- Add x-mint.href /en/ prefix to all EN OpenAPI specs (was missing, caused 404)
- Add x-mint.metadata.sidebarTitle to all operations for correct bilingual sidebar labels
- Create developer guide pages: Quick Start (merged rate-limits), API Catalog, Pagination
- Quick Start includes Open API vs Webhooks/Events comparison at top
- API Catalog lists all 214 endpoints with clickable links organized by module
- Move route rules outside channels group, next to integrations
- Navbar API Reference link points to Quick Start page
- Update pagination page links from old docs URLs to new API reference paths
- Remove RequestExample from introduction (not an API schema page)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…n to home

- Move glossary.md from .cursor/skills/ to repo root for easier access
- Update CLAUDE.md, README.md, README_zh.md to reference new glossary path
- Add api-reference/ and glossary.md to directory structure in READMEs
- Add Developer section to both zh/home.mdx and en/home.mdx with links
  to Quick Start, API Catalog, and Pagination pages

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ysyneu ysyneu merged commit 8093c51 into main Apr 12, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant